introduce zephyr into firmware monorepo #4449

TychoVrahe · 2024-12-16T08:52:56Z

This PR introduces zephyr, or rather NCS, to firmware monorepo. Zephyr is used for implementing a BLE gateway.

There is still work to be done, but i would like to get this into main soon, as it will allow more incremental work and ease review of things that affect both core and BLE, like communication and so.

But this should be good enough to:

run on both T3W1 boards, the devkit1 and revA
should be clear from readme itself how to build and flash this.

Reviewers:
@matejcik please check the structure of the added stuff
@cepetr general architectural comments, no need to deep dive into the code, unless you want to.
@hiviah please look at the BLE specific code in /nordic/trezor/trezor-ble

fixes #4301

github-actions · 2024-12-16T08:54:15Z

core UI changes	device test	click test	persistence test
T2T1 Model T	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
T3B1 Safe 3	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
T3T1 Safe 5	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
All	main(screens)

[no changelog]

There are two overlays because one is without recovery/update and one with. [no changelog]

…ader pin [no changelog]

[no changelog]

… device [no changelog]

[no changelog]

hiviah · 2025-02-04T13:28:34Z

I'll add notes as they come to me.

We seem to have mcuboot overlay missing in nordic/trezor/west.yml, here is a sample one, we need our own fork of mcuboot.

    - name: mcuboot
      url: https://github.com/hiviah/mcuboot
      path: bootloader/mcuboot
      revision: edfe1e1465dbc698bf9a195816247913490ab391

Also mcboot itself has several boots inside it, IIRC we are using the boot_serial one (need to keep in mind when one changes things and things don't appear to change).

hiviah · 2025-02-04T15:48:16Z

nordic/trezor/README.md

+
+Update the modules:
+```sh
+west update


Can't yet find a way to have common SDK source so that it's not repeated by each repo clone (since now whole repo build is doubled to some 8 GB). Theoretically only build dir needs to be separate per project, but by default they clobber over each other.

we probably could put the west.yml into firmware repo root. then it would initialize the SDK outside of the firmware repo directory, and you could share it, but potential differences between west.yml might cause headaches.

But you get the additional SDK bloat only per clone when you actually west init and west update, which might not be that often

I have lots of clones usually, 12 ATM and that is after I cleaned up some. I keep some older milestones, because due to number of components it's not always easy or possible to go back if you need to try if a bug was introduced by one of 3 compiler(s), components.

What I meant I think from the docs you can have one SDK dir - and inside it several versions of SDK like 2.6.2 or 2.7.0, and your build is outside the SDK dir structure and is always separate.

Once you run the insane ncs shell you set the build for a particular version of SDK+trezor-ble, but no need to have extra SDK clones.

At least in this case west seems to helpful by giving you hint to use --build-dir to avoid SDK clones by:

ERROR: Build directory "/home/ondro/work/satoshilabs/repos/ncs/build" is for application "/home/ondro/work/satoshilabs/repos/ncs/testapp3", but source directory "/home/ondro/work/satoshilabs/repos/trezor-firmware.new-zephyr/nordic/trezor" was specified; please clean it, use --pristine, or use --build-dir to set another build directory

So for example you can make even builds for different boards with the same SDK just by changing the build dir (here e.g. run from ncs shell innordic directory):

west build trezor/./trezor-ble -b t3w1_d1_nrf52833 --build-dir=bleeeee --sysbuild

Unfortunately it seems build needs to be working directory with all its shitty mess modules brought in, spawn of Santa (you'd wish it was Satan) with all-year christmas music playing non-stop for eternity in closed room.

hiviah

Not tested on device, but otherwise LGTM.

Just make the nordic/trezor/west.yml to point to our mcuboot that needs to be created and check it builds (took the rev id from what we are using to build now with 2.6.2) :

- name: mcuboot
  url: https://github.com/trezor/mcuboot
  path: bootloader/mcuboot
  revision: daf2946a0f07a14b57bd69d29ac4cdde6f810fb7

cepetr · 2025-02-06T09:03:40Z

.gitignore

@@ -11,3 +11,13 @@ __pycache__/
 proto.gv*
 .DS_Store
 crypto/tests/libtrezor-crypto.so.dSYM/
+/nordic/.west/


How about to move these into /nordic/.gitignore folder?

TychoVrahe · 2025-02-06T13:23:51Z

We seem to have mcuboot overlay missing in nordic/trezor/west.yml, here is a sample one, we need our own fork of mcuboot.

Yes, lets do it in separate PR, as we don't have proper repo yet. I created an issue: #4585

TychoVrahe self-assigned this Dec 16, 2024

TychoVrahe force-pushed the tychovrahe/zephyr/introduction branch from bc3bbe8 to 09a894e Compare December 16, 2024 10:22

TychoVrahe mentioned this pull request Dec 30, 2024

Zephyr/NCS mcuboot partition table and overlays #4452

Closed

TychoVrahe force-pushed the tychovrahe/zephyr/introduction branch 4 times, most recently from 10ed2af to a260f74 Compare January 20, 2025 16:03

TychoVrahe force-pushed the tychovrahe/zephyr/introduction branch 2 times, most recently from cae09d4 to cc950f7 Compare January 23, 2025 09:19

TychoVrahe marked this pull request as ready for review January 23, 2025 09:41

TychoVrahe requested review from matejcik, cepetr and hiviah January 23, 2025 09:41

matejcik approved these changes Jan 23, 2025

View reviewed changes

TychoVrahe and others added 10 commits January 24, 2025 09:42

feat(nordic): introduce NCS/zephyr into firmware monorepo

eeb21e0

[no changelog]

feat(ble): add partition image for bootloader and bootloader overlays

a478efd

There are two overlays because one is without recovery/update and one with. [no changelog]

feat(ble): integrate MCU boot into trezor-ble app, add stay in bootlo…

69c2641

…ader pin [no changelog]

refactor(ble): cleanup of trezor ble code

f3dfc27

[no changelog]

feat(ble): power management

0e25b89

[no changelog]

chore(ble): debug overlay for trezor-ble

53f0a84

[no changelog]

feat(ble): add command to erase bond belonging to currently connected…

69679d9

… device [no changelog]

feat(ble): support setting device name from trezor

b8b27a3

[no changelog]

refactor(nordic): rename west to nordic

f8f4a30

[no changelog]

chore(ble): cleanup of ble code

58b321a

TychoVrahe force-pushed the tychovrahe/zephyr/introduction branch from cc950f7 to 58b321a Compare January 24, 2025 08:42

fixup! chore(ble): cleanup of ble code

5f8eef5

hiviah reviewed Feb 4, 2025

View reviewed changes

hiviah requested changes Feb 4, 2025

View reviewed changes

cepetr reviewed Feb 6, 2025

View reviewed changes

TychoVrahe mentioned this pull request Feb 6, 2025

include forked MCUboot version to west setup #4585

Open

fixup! chore(ble): cleanup of ble code

02cfab1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

introduce zephyr into firmware monorepo #4449

introduce zephyr into firmware monorepo #4449

TychoVrahe commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading

hiviah commented Feb 4, 2025

hiviah Feb 4, 2025

TychoVrahe Feb 5, 2025

hiviah Feb 5, 2025

hiviah left a comment

cepetr Feb 6, 2025

TychoVrahe commented Feb 6, 2025

introduce zephyr into firmware monorepo #4449

Are you sure you want to change the base?

introduce zephyr into firmware monorepo #4449

Conversation

TychoVrahe commented Dec 16, 2024 • edited Loading

github-actions bot commented Dec 16, 2024 • edited Loading

hiviah commented Feb 4, 2025

hiviah Feb 4, 2025

Choose a reason for hiding this comment

TychoVrahe Feb 5, 2025

Choose a reason for hiding this comment

hiviah Feb 5, 2025

Choose a reason for hiding this comment

hiviah left a comment

Choose a reason for hiding this comment

cepetr Feb 6, 2025

Choose a reason for hiding this comment

TychoVrahe commented Feb 6, 2025

TychoVrahe commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading